Drag-and-drop input manipulator recognizes the drag-and-drop gesture from incoming touch events. More...
#include <kanzi/core.ui/input/drag_and_drop_manipulator.hpp>
Classes | |
class | CanceledMessageArguments |
Message arguments for the drag-and-drop cancel message. More... | |
class | FinishedMessageArguments |
Message arguments for drag-and-drop finished message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | MovedMessageArguments |
Message arguments for drag-and-drop moved message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
class | StartedMessageArguments |
Message arguments for drag-and-drop started message. Inherits argument properties from InputManipulator::InputMessageArguments. More... | |
Public Member Functions | |
void | setPressDuration (chrono::milliseconds pressDuration) |
Set the duration in milliseconds of the long press before drag-and-drop starts. The default duration is 500ms. | |
Public Member Functions inherited from kanzi::InputManipulator | |
void | attach (Node &node) |
Attaches an input manipulator to a node. | |
void | cancel () |
Notify manipulator of touch canceling. | |
void | detach () |
Detaches an input manipulator. | |
Node * | getAttachedNode () const |
Gets the node to which the input manipulator is attached. | |
InputManipulator * | getDependantManipulator () const |
Gets the dependant input manipulator. | |
EventRoutingMode | getEventRoutingMode () |
Returns the current input event routing mode. | |
InputManipulatorWeakPtr | getFailManipulator () const |
Gets the fail manipulator. | |
State | getState () const |
Get the state of an input manipulator. | |
KZ_DEPRECATED TouchEventRoutingMode | getTouchEventRoutingMode () |
Returns the current touch event routing mode. | |
ManipulatorType | getType () const |
Returns the type of the input manipulator. | |
bool | isActive () const |
Checks whether an input manipulator is in active state. | |
bool | isAttached () const |
Tells whether the input manipulator is attached to a node. | |
bool | isCancelable () const |
Returns whether an input manipulator is in a cancelable state. | |
bool | isResettable () const |
Returns whether an input manipulator is in a resettable state. | |
void | requireToFail (InputManipulatorWeakPtr manipulatorToFail) |
Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. | |
void | reset () |
Reset the manipulator. | |
void | setEventRoutingMode (EventRoutingMode mode) |
Sets the input event routing mode that you want the input manager to use when distributing the input event data to manipulators. | |
void | setReferenceNode (NodeWeakPtr referenceNode) |
Override the attached node as the hit test reference node. | |
void | setState (State state) |
Set the state of an input manipulator. | |
KZ_DEPRECATED void | setTouchEventRoutingMode (TouchEventRoutingMode mode) |
Sets the touch event routing mode that you want the input manager to use when distributing the touch points to input manipulators. | |
~InputManipulator () override | |
Destructor. | |
Public Member Functions inherited from kanzi::Object | |
AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. | |
void | applyObjectStyles () |
Apply all styles for an object node. | |
Domain * | getDomain () const |
Returns the domain the object belongs to. | |
const Metaclass * | getDynamicMetaclass () const override |
Returns the metaclass of the dynamic type of the object. | |
MainLoopScheduler * | getMainLoopScheduler () const |
Returns the MainLoopScheduler instance of the associated Domain. | |
detail::MessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. | |
ScriptingContextSharedPtr | getScriptingContext () const |
Gets the scripting context of the object. | |
Object (Domain *domain) | |
void | setScriptingContext (ScriptingContextSharedPtr context) |
Sets the scripting context of the object. | |
void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. | |
~Object () override | |
Public Member Functions inherited from kanzi::MetaObject | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. | |
virtual | ~MetaObject () |
Public Member Functions inherited from kanzi::PropertyObject | |
template<typename DataType > | |
void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
template<typename DataType > | |
void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
Adds a property modifier without notifying handlers. | |
template<typename DataType > | |
void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
template<typename DataType > | |
void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
PropertyStorageContainer::iterator | beginPropertyStorage () |
Returns the begin iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
Returns the begin iterator to the internal property storage container. | |
void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
Copies local value of single property from another object. | |
void | copyLocalValues (const PropertyObject &other) |
Copies all local values from another object. | |
PropertyStorageContainer::iterator | endPropertyStorage () |
Returns the end iterator to the internal property storage container. | |
PropertyStorageContainer::const_iterator | endPropertyStorage () const |
Returns the end iterator to the internal property storage container. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. | |
template<typename DataType > | |
optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property type. | |
template<typename DataType > | |
PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property disregarding modifiers. | |
template<typename DataType > | |
size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
Gets number of current notification handlers for given property type. | |
bool | hasBaseValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value, disregarding modifiers. | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. | |
bool | hasNonClassValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a value of any precedence higher than class default value set for the property. | |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. | |
bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
Virtual function to handle property change notifications. | |
PropertyObject () | |
void | removeKzbProperties () |
Remove all KZB properties. | |
void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
Remove all KZB properties that are not included in a given set. | |
template<typename DataType > | |
void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. | |
template<typename DataType > | |
void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
template<typename DataType > | |
void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
template<typename DataType > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
Sets the local value of a property type. | |
void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. | |
virtual | ~PropertyObject () |
Static Public Member Functions | |
static DragAndDropManipulatorSharedPtr | create (Domain *domain, string_view="") |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Static Public Member Functions inherited from kanzi::Object | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Static Public Member Functions inherited from kanzi::MetaObject | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
Static Public Attributes | |
static MessageType< CanceledMessageArguments > | CanceledMessage |
Message type that notifies about the cancellation of the drag-and-drop gesture. | |
static MessageType< FinishedMessageArguments > | FinishedMessage |
Message type for notifying end of the recognized drag-and-drop gesture. | |
static MessageType< MovedMessageArguments > | MovedMessage |
Message type for notifying update on position for the recognized gesture. | |
static MessageType< StartedMessageArguments > | StartedMessage |
Message type for notifying the beginning of the drag-and-drop gesture. | |
Additional Inherited Members | |
Public Types inherited from kanzi::InputManipulator | |
enum | EventRoutingMode { RoutingBubbling , RoutingTunneling } |
Enumeration for the available input event routing modes. More... | |
enum class | ManipulatorType { TouchInputHandler , KeyInputHandler } |
Enumeration for the input manipulator type. More... | |
enum | State { StateReady , StatePossible , StateBegin , StateChange , StateEnd , StateFail , StateDelayed , StateCanceled } |
Enumeration for possible input manipulator states during touch, mouse, or key input sequence. More... | |
using | TouchEventRoutingMode |
Enumeration for the available touch event routing modes. | |
using | TouchPointsConstIterator |
using | TouchPointsContainer |
Public Types inherited from kanzi::PropertyObject | |
typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
Protected Types inherited from kanzi::Object | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. | |
Static Protected Member Functions inherited from kanzi::InputManipulator | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. | |
Drag-and-drop input manipulator recognizes the drag-and-drop gesture from incoming touch events.
It generates messages required to implement the logic for objects which react to the drag-and-drop gesture. For example, use the drag-and-drop input manipulator to move objects in an application.
To receive the drag moved events, add the message handler for the MovedMessage message.
First create a handler method:
Then add a message handler for your node:
|
explicitprotected |
Constructor.
|
static |
|
inlinestatic |
void kanzi::DragAndDropManipulator::setPressDuration | ( | chrono::milliseconds | pressDuration | ) |
Set the duration in milliseconds of the long press before drag-and-drop starts. The default duration is 500ms.
|
overrideprotectedvirtual |
InputManipulator::notifyTouchInside implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::notifyTouchOutside implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::onReset implementation.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
Kanzi calls this when DragAndDropManipulator is canceled.
When you call this method it generates CanceledMessage.
Reimplemented from kanzi::InputManipulator.
|
overrideprotectedvirtual |
InputManipulator::isCancelableOverride implementation.
Reimplemented from kanzi::InputManipulator.
Update the drag-and-drop gesture state with touch event.
|
protected |
Timer callback for successful long press.
|
static |
Message type for notifying the beginning of the drag-and-drop gesture.
StartedMessage is generated after successful long press over the node area.
|
static |
Message type for notifying update on position for the recognized gesture.
MovedMessage is generated when the tracked touch has moved while the drag is active.
|
static |
Message type for notifying end of the recognized drag-and-drop gesture.
FinishedMessage is generated when the tracked touch is released while the drag is active.
|
static |
Message type that notifies about the cancellation of the drag-and-drop gesture.
CanceledMessage is generated when DragAndDropManipulator is canceled.